Summary

Creates a web tree from a hierarchical document structure.

Component properties
Category AS Menu
Version 1.0
Complies with Xhtml 1.0 / 1.1 rules Yes
Supported server programming languages C# Visual Basic.NET
Output content type block

When placed on a Web page this component will render an expanded tree based on a document hierarchy as the sample below shows.

The Web Tree component

When to use

This component is typically used when there is a need to show an expanded Web tree representation of the Web site. Often the source of this tree is based on the main menu of the Web site.

Programming interface

Parameters

Document ID
The document that acts as the root of the document hierarcy that forms the tree.
Formatting options
CSS Class name
A CSS class name to use when formatting the list
DisplayRoot
Display root document
Clickable roots
Check this to navigate when user clicks on a root document
AddLevelInformation
Check this to add document level information on each node
Caching options
Cache name
Cache key name. This name MUST be unique within the site since it is used to store application or session cache data.
Cache options
One of the following options:
  • No cache
    Do not cache the the webmap, the webmap will be rendered from the specified source each time it reloads.
  • Use session cache
    Cache webmap using session variables. Recommended for an intranet.
  • Use application cache
    Cache the webmap using application variables. Should not be used in an intranet with security permissions set for the hiearchy items.
Application cache timeout
Timeout in minutes for application cache, 0 = no timeout

Remarks

General remarks with menu components

All menu driven components uses the Content Studio menu API:s and hierarchy document structures. The caller must have BROWSE permission to all items displayed and every item must be live and published. When the menu renders Content Studio traverses through the entire document tree and whenever there is a document that is not available to the caller the traverse operation breaks at this point. This have the effect that any object that is a child of a unavailable document will be left out since the tree is broken at that point.